/*
 * Fichier: FileBook.java
 * Crée le: 08 septembre 2007.
 * Modifié: 26 avril 2012.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.io;



import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

import javaexos.business.Book;
import javaexos.business.Chapter;
import javaexos.business.Exercise;
import javaexos.model.ChapterMutableModel;
import javaexos.model.ExerciseModel;
import javaexos.model.ExerciseMutableModel;
import javaexos.tools.Constants;
import javaexos.tools.Log;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;



/**
 * <p>Classe pemettant de charger les informations des chapitres contenus dans des fichiers XML.</p>
 * @author Sébastien ESTIENNE.
 */
public class XMLFileBook extends Book
{
   /** Logger. */
   private static final Logger LOGGER = Log.getInstance().getLogger("javaexos.io.XMLFileBook");

   /** Balise chapitre. */
   private static final String CHAPTER_MARKER = "chapitre";

   /** Attribut numéro. */
   private static final String NUMBER_ATTRIBUTE = "numero";
   
   /** Attribut titre. */
   private static final String TITLE_ATTRIBUTE = "titre";
   
   /** Attribut nom. */
   private static final String NAME_ATTRIBUTE = "nom";

   /** Attribut date. */
   private static final String DATE_ATTRIBUTE = "date";

   /** Attribut auteur. */
   private static final String AUTHOR_ATTRIBUTE = "auteur";

   /** Attribut valide. */
   private static final String VALIDATED_ATTRIBUTE = "valide";

   /** Balise mots clés. */
   private static final String KEYWORDS_MARKER = "motscles";

   /** Balise présentation. */
   private static final String PRESENTATION_MARKER = "presentation";

   /** Balise notions. */
   private static final String NOTIONS_MARKER = "notions";

   /** Balise élement. */
   private static final String ELEMENT_MARKER = "element";

   /** Balise contributeurs. */
   private static final String CONTRIBUTORS_MARKER = "contributeurs";

   /** Balise exercice. */
   private static final String EXERCISE_MARKER = "exercice";

   /** Attribut type. */
   private static final String TYPE_ATTRIBUTE = "type";

   /** Balise énoncé. */
   private static final String DECLARATION_MARKER = "enonce";

   /** Balise images. */
   private static final String IMAGES_MARKER = "images";

   /** Balise fichiers. */
   private static final String FILES_MARKER = "fichiers";

   /** Attribut main. */
   private static final String MAIN_ATTRIBUTE = "main";

   /** Séparateur de date. */
   private static final String DATE_SEPARATOR = "-";

   /** Format de la date. */
   public static final String DATE_FORMAT = "aaaa-mm-jj";

   /** Fabrique de documents. */
   private DocumentBuilderFactory docFactory;

   /** Constructeur de documents. */
   private DocumentBuilder docBuilder;

   /** Document représentant le fichier xml. */
   private Document document;

   /** Nom du fichie XML courant. */
   private String currentXmlFile;


   /**
    * <p>Constructeur par défaut de livre.</p>
    */
   public XMLFileBook()
   {
      // Appel du constructeur de la superclasse.
      super();
   }


   /**
    * <p>Charge le fichier XML spécifié par son chemin.</p><p></p>
    * @param chapterStream Le flux vers le fichier XML à charger.
    * @return true si le chargement s'est fait avec succès, false sinon.
    * @throws IOException Si une erreur d'entrée / sortie se produit.
    */
   private boolean loadXMLFile(InputStream chapterStream) throws IOException
   {
      assert (chapterStream != null) : "'chapterStream' ne doit pas être null!";

      boolean result = true;

      try
      {
         // Création d'une fabrique de documents.
         this.docFactory = DocumentBuilderFactory.newInstance();

         // Création d'un constructeur de documents.
         this.docBuilder = this.docFactory.newDocumentBuilder();

         // Lecture du contenu d'un fichier XML avec DOM.
         this.document = this.docBuilder.parse(chapterStream);
      }
      catch(ParserConfigurationException pce)
      {
         LOGGER.log(Level.SEVERE, this.currentXmlFile
               + " : Erreur de configuration du parseur DOM.");
         result = false;
      }
      catch(SAXException se)
      {
         LOGGER.log(Level.SEVERE, this.currentXmlFile + " : Erreur lors du parsing du document.");
         result = false;
      }

      return result;
   }


   /**
    * <p>Charge les donnés de tous les chapitres.</p>
    */
   @Override
   public void loadChapters()
   {
      URL url = null;
      ChapterMutableModel chapter;
      
      // Supprime les chapitres existants avant de tout charger.
      this.chapters.clear();

      // Parcours la liste des chapitres et les chargent.
      for(int i = 0; i < Constants.NB_CHAPTERS; i++)
      {
         // Nom du fichier XML.
         this.currentXmlFile = Constants.CHAPTERS_NAME.replace("?", Integer.toString(i + 1) + ".xml");

         // Récupère l'URL vers le chapitre.
         url = getClass().getResource(Constants.DATA_PATH + "/" + this.currentXmlFile);

         if(url != null)
         {
            // Charge un chapitre à partir d'un fichier XML.
            chapter = loadChapter(url);
            
            // Ajoute le chapitre.
            if(chapter != null)
            {
               this.chapters.add(chapter);
            }
            
            // Lance un événement de chapitre chargé.
            String title;
            if(chapter != null)
            {
               title = chapter.getTitle();
            }
            else
            {
               title = "";
            }
            fireChapterLoaded(i + 1, title);
         }
         else
         {
            LOGGER.log(Level.SEVERE, this.currentXmlFile + " : Le document XML n'exite pas.");
         }
      }

      // Classe la liste des chapitres.
      Collections.sort(this.chapters);
   }
   
   /**
    * <p>Extrait les informations d'un chapitre contenues dans un fichier XML.</p>
    * @param filename Le chemin vers le fichier.
    * @return Retourne un chapitre avec les informations du fichier.
    */
   public ChapterMutableModel parseChapter(URL filename)
   {
      // Vérifie que l'URL est définie.
      if(filename == null)
      {
         return null;
      }
      
      // Défini le nom du fichier XML.
      this.currentXmlFile = new File(filename.getPath()).getName();
      
      // Return chapter.
      return loadChapter(filename);
   }


   /**
    * <p>Charge les informations d'un chapitre contenues dans un fichier XML.</p>
    * @param filename Le chemin vers le fichier.
    * @return Retourne un chapitre avec les informations du fichier.
    */
   private ChapterMutableModel loadChapter(URL filename)
   {
      assert (filename != null) : "'filename' ne doit pas être null!";
      
      // Charge le fichier XML.
      InputStream chapterStream = null;
      boolean result = false;
      try
      {
         chapterStream = filename.openStream();
         result = loadXMLFile(chapterStream);
      }
      catch(IOException e)
      {
         LOGGER.log(Level.SEVERE, this.currentXmlFile
               + " : Le document XML n'a pas pu être ouvert.");
      }
      finally
      {
         try
         {
            if(chapterStream != null)
            {
               chapterStream.close();
            }
         }
         catch(IOException e)
         {
            LOGGER.log(Level.SEVERE, this.currentXmlFile
                  + " : Le document XML n'a pas pu être fermé.");
         }
      }

      // Renvoie null si le fichier XML ne s'est pas chargé correctement.
      if(!result)
      {
         return null;
      }

      // Le chapitre à charger.
      ChapterMutableModel chapter = new Chapter();

      // Racine du document.
      Element root = this.document.getDocumentElement();

      // Renvoie null si le noeud est incorrect.
      if(!root.getNodeName().equals(CHAPTER_MARKER))
      {
         LOGGER.log(Level.SEVERE, this.currentXmlFile
               + " : Le document XML n'est pas conforme, balise " + CHAPTER_MARKER
               + " non trouvée.");
         chapter = null;
         return null;
      }

      // Informations générales du chapitre.
      if(!loadChapterProperties(root, chapter))
      {
         chapter = null;
         return null;
      }

      // Informations spécifiques.
      List<ExerciseMutableModel> exercises = new ArrayList<ExerciseMutableModel>();
      NodeList nodes = root.getChildNodes();
      Node node = null;
      for(int i = 0; i < nodes.getLength(); i++)
      {
         node = nodes.item(i);

         // Mots clés.
         if(node.getNodeName().equals(KEYWORDS_MARKER))
         {
            loadChapterKeywords(node, chapter);
         }
         // Présentation.
         else if(node.getNodeName().equals(PRESENTATION_MARKER))
         {
            loadChapterPresentation(node, chapter);
         }
         // Notions.
         else if(node.getNodeName().equals(NOTIONS_MARKER))
         {
            loadChapterNotions(node, chapter);
         }
         // Contributeurs.
         else if(node.getNodeName().equals(CONTRIBUTORS_MARKER))
         {
            loadChapterContributors(node, chapter);
         }
         // Exercices.
         else if(node.getNodeName().equals(EXERCISE_MARKER))
         {
            ExerciseMutableModel exercise = loadExercise(node);
            if(exercise != null)
            {
               exercise.setChapter(chapter);
               exercises.add(exercise);
            }
         }
      }
      Collections.sort(exercises);
      chapter.setExercises(exercises);

      // Vérifie si les mots clés, la présentation, les notions et les contributeurs sont remplis.
      checkChapter(chapter);

      return chapter;
   }


   /**
    * <p>Renseigne les propriétés d'un chapitre.</p>
    * @param element L'élément courant dans le fichier XML.
    * @param chapter Le chapitre à renseigner.
    * @return true si la lecture des propriétés c'est bien passée sinon false.
    */
   private boolean loadChapterProperties(Element element, ChapterMutableModel chapter)
   {
      // Numéro du chapitre.
      if(element.hasAttribute(NUMBER_ATTRIBUTE))
      {
         try
         {
            chapter.setNumber(Integer.parseInt(element.getAttribute(NUMBER_ATTRIBUTE)));
         }
         catch(NumberFormatException e)
         {
            LOGGER.log(Level.WARNING, this.currentXmlFile
                  + " : Le numéro du chapitre n'est pas un nombre.");
            return false;
         }
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le numéro du chapitre est manquant.");
         return false;
      }

      // Titre du chapitre.
      if(element.hasAttribute(TITLE_ATTRIBUTE))
      {
         chapter.setTitle(element.getAttribute(TITLE_ATTRIBUTE));
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le titre du chapitre est manquant.");
         return false;
      }
      
      // Nom du chapitre.
      if(element.hasAttribute(NAME_ATTRIBUTE))
      {
         chapter.setName(element.getAttribute(NAME_ATTRIBUTE));
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le nom du chapitre est manquant.");
         return false;
      }

      // Date du chapitre (dernière modification).
      if(element.hasAttribute(DATE_ATTRIBUTE))
      {
         Calendar calendar = Calendar.getInstance();
         String date = element.getAttribute(DATE_ATTRIBUTE);
         String[] splitDate = date.split(DATE_SEPARATOR);
         if(splitDate.length == 3)
         {
            try
            {
               calendar.set(Integer.parseInt(splitDate[0]), Integer.parseInt(splitDate[1]) - 1, 
                     Integer.parseInt(splitDate[2]));
            }
            catch(NumberFormatException e)
            {
               LOGGER.log(Level.WARNING, this.currentXmlFile
                     + " : Le format de la date n'est pas correct (" + DATE_FORMAT + ").");
               return false;
            }
         }
         else
         {
            LOGGER.log(Level.WARNING, this.currentXmlFile
                  + " : Le format de la date n'est pas correct (" + DATE_FORMAT + ").");
            return false;
         }
         chapter.setCreation(calendar);
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : La date du chapitre est manquante.");
         return false;
      }

      // Auteur du chapitre.
      if(element.hasAttribute(AUTHOR_ATTRIBUTE))
      {
         chapter.setAuthor(element.getAttribute(AUTHOR_ATTRIBUTE));
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : L'auteur du chapitre est manquant.");
         return false;
      }

      // Indique si le chapitre a été validé.
      if(element.hasAttribute(VALIDATED_ATTRIBUTE))
      {
         chapter.setValidated(Boolean.parseBoolean(element.getAttribute(VALIDATED_ATTRIBUTE)));
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile 
               + " : La validité du chapitre est manquant.");
         return false;
      }

      return true;
   }


   /**
    * <p>Renseigne les mots clés d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param chapter Le chapitre à renseigner.
    */
   private void loadChapterKeywords(Node node, ChapterMutableModel chapter)
   {
      String keyWords = node.getTextContent();
      String[] splitKeyWords = keyWords.split(",");
      List<String> keyWordsList = new ArrayList<String>();
      for(int j = 0; j < splitKeyWords.length; j++)
      {
         keyWordsList.add(splitKeyWords[j].trim());
      }
      chapter.setKeyWords(keyWordsList);
   }


   /**
    * <p>Renseigne la présentation d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param chapter Le chapitre à renseigner.
    */
   private void loadChapterPresentation(Node node, ChapterMutableModel chapter)
   {
      String presentation = node.getTextContent();
      if(presentation == null)
      {
         presentation = "";
      }
      chapter.setPresentation(presentation);
   }


   /**
    * <p>Renseigne les notions d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param chapter Le chapitre à renseigner.
    */
   private void loadChapterNotions(Node node, ChapterMutableModel chapter)
   {
      NodeList nodes = node.getChildNodes();
      List<String> notions = new ArrayList<String>();
      Node node2 = null;
      for(int j = 0; j < nodes.getLength(); j++)
      {
         node2 = nodes.item(j);
         if(node2.getNodeName().equals("element"))
         {
            notions.add(node2.getTextContent());
         }
      }
      chapter.setNotions(notions);
   }


   /**
    * <p>Renseigne les contributeurs d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param chapter Le chapitre à renseigner.
    */
   private void loadChapterContributors(Node node, ChapterMutableModel chapter)
   {
      NodeList nodes = node.getChildNodes();
      List<String> contributors = new ArrayList<String>();
      Node node2 = null;
      for(int j = 0; j < nodes.getLength(); j++)
      {
         node2 = nodes.item(j);
         if(node2.getNodeName().equals(ELEMENT_MARKER))
         {
            contributors.add(node2.getTextContent());
         }
      }
      chapter.setContributors(contributors);
   }


   /**
    * <p>Charge les informations d'un exercice à partir du fichier XML.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @return Retourne l'exercice correspondant au noeud.
    */
   private ExerciseMutableModel loadExercise(Node node)
   {
      ExerciseMutableModel exercise = new Exercise();

      // Informations générales de l'exercice.
      if(!loadExerciseProperties(node, exercise))
      {
         exercise = null;
         return null;
      }

      // Informations spécifiques de l'exercice.
      NodeList nodes = node.getChildNodes();
      Node node2 = null;
      for(int j = 0; j < nodes.getLength(); j++)
      {
         node2 = nodes.item(j);

         // Enoncé.
         if(node2.getNodeName().equals(DECLARATION_MARKER))
         {
            loadExerciseDeclaration(node2, exercise);
         }
         // Images.
         else if(node2.getNodeName().equals(IMAGES_MARKER))
         {
            loadExerciseImages(node2, exercise);
         }
         // Fichiers.
         else if(node2.getNodeName().equals(FILES_MARKER))
         {
            loadExerciseFiles(node2, exercise);
         }
      }

      // Vérifie que l'énoncé, les images et fichiers sont remplis.
      checkExercise(exercise);

      return exercise;
   }


   /**
    * <p>Renseigne la présentation d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param exercise L'exercice à renseigner.
    * @return true si la lecture des propriétés c'est bien passée sinon false.
    */
   private boolean loadExerciseProperties(Node node, ExerciseMutableModel exercise)
   {
      NamedNodeMap infos = node.getAttributes();

      // Numéro d'exercice.
      if(infos.getNamedItem(NUMBER_ATTRIBUTE) != null)
      {
         try
         {
            exercise.setNumber(Integer
                  .parseInt(infos.getNamedItem(NUMBER_ATTRIBUTE).getNodeValue()));
         }
         catch(NumberFormatException e)
         {
            LOGGER.log(Level.WARNING, this.currentXmlFile
                  + " : Le numéro de l'exercice n'est pas un nombre.");
            return false;
         }
      }
      else
      {
         LOGGER
               .log(Level.WARNING, this.currentXmlFile + " : Le numéro d'un exercice est manquant.");
         return false;
      }

      // Titre de l'exercice.
      if(infos.getNamedItem(TITLE_ATTRIBUTE) != null)
      {
         exercise.setTitle(infos.getNamedItem(TITLE_ATTRIBUTE).getNodeValue());
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le titre de l'exercice "
               + exercise.getNumber() + " est manquant.");
         return false;
      }

      // Nom de l'exercice.
      if(infos.getNamedItem(NAME_ATTRIBUTE) != null)
      {
         exercise.setName(infos.getNamedItem(NAME_ATTRIBUTE).getNodeValue());
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le nom de l'exercice " 
               + exercise.getNumber() + " est manquant.");
         return false;
      }

      // Type de l'exercice.
      if(infos.getNamedItem(TYPE_ATTRIBUTE) != null)
      {
         exercise.setType(ExerciseModel.ExoType.valueOf(infos.getNamedItem(TYPE_ATTRIBUTE)
               .getNodeValue().toUpperCase()));
      }
      else
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : Le type de l'exercice " 
               + exercise.getNumber() + " est manquant.");
         return false;
      }

      return true;
   }


   /**
    * <p>Renseigne la présentation d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param exercise L'exercice à renseigner.
    */
   private void loadExerciseDeclaration(Node node, ExerciseMutableModel exercise)
   {
      String declaration = node.getTextContent();
      if(declaration == null)
      {
         declaration = "";
      }
      exercise.setDeclaration(declaration);
   }


   /**
    * <p>Renseigne la présentation d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param exercise L'exercice à renseigner.
    */
   private void loadExerciseImages(Node node, ExerciseMutableModel exercise)
   {
      NodeList nodes = node.getChildNodes();
      List<String> images = new ArrayList<String>();
      Node node2 = null;
      for(int k = 0; k < nodes.getLength(); k++)
      {
         node2 = nodes.item(k);
         if(node2.getNodeName().equals(ELEMENT_MARKER))
         {
            images.add(node2.getTextContent());
         }
      }
      exercise.setImages(images);
   }


   /**
    * <p>Renseigne la présentation d'un chapitre.</p>
    * @param node Le noeud courant dans le fichier XML.
    * @param exercise L'exercice à renseigner.
    */
   private void loadExerciseFiles(Node node, ExerciseMutableModel exercise)
   {
      NodeList nodes = node.getChildNodes();
      List<String> files = new ArrayList<String>();
      Node node2 = null;
      for(int k = 0; k < nodes.getLength(); k++)
      {
         node2 = nodes.item(k);
         if(node2.getNodeName().equals(ELEMENT_MARKER))
         {
            // Ajout de la classe dans la liste des fichiers.
            files.add(node2.getTextContent());

            // Classe principale.
            NamedNodeMap infos = node2.getAttributes();
            if(infos != null)
            {
               Node node3 = infos.getNamedItem(MAIN_ATTRIBUTE);
               if(node3 != null && node3.getNodeValue().equalsIgnoreCase(Boolean.toString(true)))
               {
                  exercise.setMainClass(node2.getTextContent());
               }
            }
         }
      }
      exercise.setFiles(files);
   }


   /**
    * <p>Informe dans un fichier de log si des informations d'un chapitre sont incomplètes.</p>
    * @param chapter Le chapitre à vérifier.
    */
   private void checkChapter(ChapterMutableModel chapter)
   {
      // Vérification des mots clés.
      if(chapter.getKeyWords().isEmpty())
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile
               + " : Aucun mot clé défini dans ce chapitre!");
      }

      // Vérification de la présentation.
      if(chapter.getPresentation().length() == 0)
      {
         LOGGER
               .log(Level.WARNING, this.currentXmlFile + " : La présentation du chapitre est vide!");
      }

      // Vérifica tion des notions.
      if(chapter.getNotions().isEmpty())
      {
         LOGGER
               .log(Level.WARNING, this.currentXmlFile + " : Le chapitre ne comporte aucun notion!");
      }

      // Vérification des contributeurs.
      if(chapter.getContributors().isEmpty())
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile
               + " : Le chapitre ne comporte aucun contributeur!");
      }
      
      // Vérification du nombre d'exercices.
      if(chapter.getContributors().isEmpty())
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile
               + " : Le chapitre ne comporte aucun exercice!");
      }
   }


   /**
    * <p>Informe dans un fichier de log si des informations d'un exercice sont incomplètes.</p>
    * @param exercise L'exercice à vérifier.
    */
   private void checkExercise(ExerciseMutableModel exercise)
   {
      // Vérification de l'énoncé.
      if(exercise.getDeclaration().length() == 0)
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : L'énoncé de l'exercice " 
               + exercise.getNumber() + " est vide!");
      }

      // Vérifications des images.
      if(exercise.getImages().isEmpty())
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : L'exercice " + exercise.getNumber()
               + " ne comporte aucune image!");
      }

      // Vérifications des fichiers.
      if(exercise.getFiles().isEmpty())
      {
         LOGGER.log(Level.WARNING, this.currentXmlFile + " : L'exercice " + exercise.getNumber() 
               + " ne comporte aucun fichier!");
      }
   }
}
